home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / fap110.zip / FAP.DOC < prev    next >
Text File  |  1992-12-29  |  11KB  |  288 lines
  1. ─ File Announcer For Points v1.10 ────── Copyright Steve Mulligan 1992 - 1993─
  2.  
  3. Well, g'day.  This is the second release of FAP.  Fresh from the Valley.  It
  4. took a long time because of this thing called <yech> school.  But, thanks to
  5. X-MAS holidays I got my act together and fixed it up and here you go.
  6. Special Thanks goes to THE GUY THAT TOLD ME TO PUT THE ALWAYS EXCLUDE KEYWORD
  7. INTO FAP (Buddy, I need your name so I can thank you.  This time, I save
  8. it on the hard disk.  Not on paper).  More special thanks go to Malcolm
  9. Campbell for letting me use OTTBETA on his BBS.  OTTBETA is a Beta Testers
  10. area for programmers in the Ottawa area.  If you want to link in, just send
  11. a NetMail to Steve Mulligan at 1:163/307.30.  More special thanks goes to
  12. Peter Beeftink for writing all of the AlwaysExclude logic.  And last but not
  13. least, Steve Mathieson, my head beta tester who really helped.  Didn't you,
  14. Steve!
  15.  
  16. NOTE : If you use FAP and you NetMail me, Steve Mulligan, at 1:163/307.30
  17.        then I will send you a NetMail every time I release a version of
  18.        FAP and I will tell you when and where I have sent it.
  19.  
  20. ─ Introduction ─
  21.  
  22.   File Announcer for Points (also called FAP) is a program that will scan
  23. any specified directory for new files and post the new files in a Squish, MSG
  24. or QBBS style message base.  It will convert RSP files to messages for you and
  25. allow you to run specific programs on certain files.  I made FAP because I
  26. like to F'REQ files a lot. Sometimes too much.  Anyhow, I get all these files
  27. in and forget that I F'REQ'ed them and when I go look in my NetFile directory,
  28. I've got a ton of files.  After a long time, I wished I had a program that
  29. would announce these files for me when they arrived.  So... I saddled up my
  30. trusty Turbo Pascal book and gathered up my beta testers and here you go.
  31. FAP.  A program that announces new files for you in a Squish, MSG or QBBS
  32. style message base.
  33.  
  34. ─ Setting Up FAP ─
  35.  
  36.   To install FAP, just copy all the files to your mailer directory (if you
  37. have one).  Files in this archive should be:
  38.  
  39.      FAP.EXE                 - Executable program you run
  40.      FAP.DOC                 - Your reading it
  41.      FAP.CFG                 - Sample config file
  42.      
  43.    After all the files are in the right spot, edit the text file FAP.CFG and
  44. change the options as necessary.  See the next section on how to set up the
  45. configuration file.
  46.  
  47. ─ FAP And The Config File ─
  48.  
  49.    Here is a list of all the config verbs that FAP understands.  All commands
  50. and parameters are not case sensitive.  They can have spaces anywhere.  If a
  51. line starts with a ; then it will be treated as a comment and skipped.
  52.  
  53. NetFile
  54.  
  55. The NetFile option tells FAP where to look for new files.  You can enter up
  56. to 8 of these.  Duplicates will be ignored.  This should point to the
  57. directory that your mailer puts new files into.
  58.  
  59. eg : NetFile d:\modem\bbs\file
  60.  
  61. FileExclude
  62.  
  63. The FileExclude verb tells FAP where to find the list of files to exclude from
  64. new file scanning.  This file holds the full path and file name of any file
  65. that has been scanned by FAP.  If a file is found in a directory and is in the
  66. FileExclude file, it is not announced.  This stops files from being announced
  67. more than once.  The default is FAP.DAT.  If a file is found in the exclude
  68. file but it is not on disk, it will then be removed from the exclude file
  69. automatically.
  70.  
  71. eg : FileExclude FAP.DAT
  72.  
  73. Area
  74.  
  75. The Area verb tells the FAP where to put the file announcements.  It should
  76. point to a Squish, MSG or QBBS style message base.  NOTE: This message base
  77. must already exist or it will not work.  THIS MUST BE INCLUDED.  THERE IS NO
  78. DEFAULT!
  79.  
  80. eg for Squish : Area d:\msgs\cvpfiles
  81. eg for MSG    : Area d:\msgs
  82. eg for QBBS   : Area d:\msgs
  83.  
  84. NumberAnnounce
  85.  
  86. The NumberAnnounce verb tells you how many files announcements will go in each
  87. message.  The default is 3.  If there are more than the number specified, it
  88. will be broken into multiple messages.  You cannot have more than 32 files per
  89. message.  Any number greater will be reset to 32.  The larger the number, the
  90. less FAP has to run it message posting routine so FAP will run a lot faster if
  91. you get many files in one transfer.
  92.  
  93. eg : NumberAnnounce 3
  94.  
  95. AreaType
  96.  
  97. The AreaType verbs tell FAP what message area to support.  Right now, FAP
  98. supports Squish and MSG bases.  Put the word Squish after AreaType to use
  99. Squish style bases.  Put the word MSG after the AreaType to use MSG type
  100. bases.  Squish is the default
  101.  
  102. eg for Squish : AreaType Squish
  103. eg for MSG    : AreaType MSG
  104. eg for QBBS   : AreaType QBBS
  105.  
  106. BoardNo
  107.  
  108. The BoardNo verb tells FAP what QBBS Board Number to post the message to. 1 is
  109. the default.  You only need this if you use QBBS (Hudson) style message bases.  This number can be between 1 and 65535.
  110.  
  111. eg : BoardNo 1
  112.  
  113. AddressFrom
  114.  
  115. The AddressFrom verb is to define the address the message is from.  This MUST
  116. be included if there is no AddressTo verb.
  117.  
  118. eg : AddressFrom 1:163/307.30
  119.  
  120. AddressTo
  121.  
  122. The AddressTo verb is to define the address the message is from.  This MUST
  123. be included if there is no AddressFrom verb.
  124.  
  125. eg : AddressTo 1:163/307.30
  126.  
  127. FAPTempFile
  128.  
  129. The FAPTempFile verb points to the temp file.  The default is NEWFILE.FAP. The 
  130. temp file simply stores the text that will go into the file announcement
  131. message.  If a file by the name given already exists, it will be erased.
  132.  
  133. eg : FAPTempFile FAP.TMP
  134.  
  135. MSGTempFile
  136.  
  137. The MSGTempFile verb points to the temp file that FAP makes uses for posting
  138. messages.  The default is FAPMSG.TMP.  If this file already exists, it will be
  139. erased.
  140.  
  141. eg : MSGTempFile FAPMSG.TMP
  142.  
  143. From
  144.  
  145. The From verb is what appears on the From line of the message.  FAP and the
  146. version is the default.  If you want the right version number displayed, do
  147. not include a from line.
  148.  
  149. eg : From FAP v1.10
  150.  
  151. To
  152.  
  153. The To verb is what appears on the To line of the message.  All is the
  154. default.
  155.  
  156. eg : To All
  157.  
  158. Subject
  159.  
  160. The Subject verb is what appears on the Subject line of the message.
  161. "New Files" is the default.  (without the surrounding quotes).
  162.  
  163. eg : Subject New Files
  164.  
  165. OriginLine
  166.  
  167. The OriginLine verb tells FAP what to put on the Origin Line of your message.
  168. DO NOT PUT YOUR ADDRESS HERE.  It will be added to the end of the Origin Line
  169. by FAP. The default is (ignore apostrophies):
  170.  
  171.           'Point System Using FAP v' + Version + ' * (' + FromAddress + ')'
  172.  
  173. Translated to real words this looks like :
  174.  
  175.           'Point System Using FAP v1.10 * (x:xxx/xxx)'
  176.  
  177. eg : OriginLine Carp Valley Point * Carp, Ontario
  178.  
  179. TICAnnounce
  180.  
  181. The TICAnnounce verb tells FAP if it should read into TIC files and announce
  182. the files that appear in them.  Valid options are Yes and No.  The default is
  183. Yes.  This is useful if you get files from a file distribution net because
  184. files you get from there often come with TIC files accompanying them.  This
  185. will allow files to have descriptions and other important information added
  186. to the file announcement.
  187.  
  188. eg : TICAnnounce Yes
  189.  
  190. RSPAnnounce
  191.  
  192. The RSPAnnounce verb tells FAP if it should convert files with the RSP
  193. extension into a message.  Valid options are Yes and No.  The default is Yes. 
  194. Sometimes when you file request a file from a BBS but you get the password
  195. wrong or the file cannot be found, they BBS will return a RSP file.  FAP will
  196. post this file to you message base.
  197.  
  198. eg : RSPAnnounce Yes
  199.  
  200. AlwaysExclude
  201.  
  202. The AlwaysExclude verb is for users who want to exclude certain files all the
  203. time.  This config verb is used mainly for people who get a lot of mail and
  204. want FAP to run before they unpack their mail.  When you run FAP before you
  205. unpack your mail, you might get *.PKT's and *.MO* files announced be mistake.
  206. AlwaysExclude takes a wild card as an argument.  You can have up to 32 of
  207. these.  There is no default but there is an example in the config file that
  208. works good for me.
  209.  
  210. eg : AlwaysExclude *.PKT
  211.  
  212. ─ Running FAP ─
  213.  
  214.   Once you have done all the above, you can run FAP.  It takes one command
  215. line argument; the config file name.  You can rename FAP.CFG to any file and
  216. then type FAP <configname> or just keep the name and run fap without any
  217. command line options.
  218.  
  219.   FAP will display a title screen and proceed to scan your directories using
  220. some calls to DOS.  It will then put a list of all files that did not appear
  221. in the ExcludeFile file in a the FAPTempFile.  FAP then shells copies this
  222. file in to the message base of your choice.  If a file did not appear in the
  223. ExcludeFile file, it will be added so that when FAP runs again, you will not
  224. get the same files announced over and over.
  225.  
  226.   FAP runs best in a batch file.  If you have a batch file to run your mailer
  227. and unpacker, make sure FAP is run AFTER the mail is unpacked. Otherwise, you
  228. will get mail packets listed in file announcements unless you use the
  229. AlwaysExclude command.
  230.  
  231.   If you continue to use FAP, I would LOVE to hear from you.  I just want to
  232. know if you like the program or you think I should stop development.  If you
  233. wish to make a comment (PLEASE) NetMail Steve Mulligan 1:163/307.30
  234.  
  235. ─ Beta Testers Wanted ─
  236.  
  237.   If you are in the 163 or 243 net or you don't mind polling long distance
  238. you are eligible to be a beta testers.  Simply NetMail Steve Mulligan at
  239. 1:163/307.30.  I will reply to you and tell you how to get the latest beta
  240. versions of software I make.
  241.  
  242. ─ On the Drawing Board ─
  243.  
  244.    This is a list of all the features my Beta Testers and I want to have added
  245. to FAP.  I'll get around to it in a while.  PLEASE ADD TO LIST AND FORWARD TO
  246. STEVE MULLIGAN 1:163/307.30.  If you want to become a Beta Tester, NetMail me
  247. and I'll send you beta releases.
  248.  
  249. 1.11ß   · Change all config errors to errorlevel to 3
  250.       All runtime errors to errorlevel 2
  251.       Finding and announcing files to errorlevel 1
  252.       No files announced to errorlevel 0
  253.     · Option to write file announcement to Text File.
  254.  
  255. 1.12ß   · Add byte count in file announcement.
  256.       Header & Footer in file announcement.
  257.  
  258. 1.13ß   · Update FileExclude at the end of program execution.
  259.  
  260. 1.14ß   · Add nodelist and other 'new file' support to FAP.
  261.       ie. Compile nodelists if they arrive
  262.           Unpack and post FIDONWS if it arrives.
  263.  
  264. 1.15ß   · Command line usage.
  265.  
  266. 1.16ß   · Allow user to change appearance of file announcements.
  267.  
  268. 1.20    · Next public release. (Mar 93)
  269.  
  270. 1.21ß   · Support FLE files.  All I have to do is get the format of
  271.       these files!  Any idea's?
  272.  
  273. 1.22ß   · Get rid of excess units and global variables.
  274.  
  275. 1.30    · Another public release.  Should be smaller and faster!
  276.       (End of Jul 93)
  277.  
  278. 1.3xß   · Misc bug stomps.
  279.  
  280. 1.40    · Probably the last release.  Alas. (End of Sep 93)
  281.  
  282. ?.??    · My file FDN.  This way, I can release updates & patches
  283.       to my users really fast.
  284.  
  285. If you have any additions to this list or any bugs, please let me know!
  286.  
  287. Steve Mulligan 1:163/307.30@fidonet.org
  288.